Builder
Lora Config
Content copied to clipboard
meshtastic.Config.LoRaConfig
Functions
Link copied to clipboard
open fun addAllIgnoreIncoming(values: Iterable<out Integer>): ConfigProtos.Config.LoRaConfig.Builder
For testing it is useful sometimes to force a node to never listen to
particular other nodes (simulating radio out of range). All nodenums listed
in ignore_incoming will have packets they send dropped on receive (by router.cpp)
Content copied to clipboard
repeated uint32 ignore_incoming = 103;
Link copied to clipboard
For testing it is useful sometimes to force a node to never listen to
particular other nodes (simulating radio out of range). All nodenums listed
in ignore_incoming will have packets they send dropped on receive (by router.cpp)
Content copied to clipboard
repeated uint32 ignore_incoming = 103;
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Bandwidth in MHz
Certain bandwidth numbers are 'special' and will be converted to the
appropriate floating point value: 31 -> 31.25MHz
Content copied to clipboard
uint32 bandwidth = 3;
Link copied to clipboard
This controls the actual hardware frequency the radio transmits on.
Most users should never need to be exposed to this field/concept.
A channel number between 1 and NUM_CHANNELS (whatever the max is in the current region).
If ZERO then the rule is "use the old channel name hash based
algorithm to derive the channel number")
If using the hash algorithm the channel number will be: hash(channel_name) %
NUM_CHANNELS (Where num channels depends on the regulatory region).
Content copied to clipboard
uint32 channel_num = 11;
Link copied to clipboard
The denominator of the coding rate.
ie for 4/5, the value is 5. 4/8 the value is 8.
Content copied to clipboard
uint32 coding_rate = 5;
Link copied to clipboard
Sets the ok_to_mqtt bit on outgoing packets
Content copied to clipboard
bool config_ok_to_mqtt = 105;
Link copied to clipboard
This parameter is for advanced users with advanced test equipment, we do not recommend most users use it.
A frequency offset that is added to to the calculated band center frequency.
Used to correct for crystal calibration errors.
Content copied to clipboard
float frequency_offset = 6;
Link copied to clipboard
Maximum number of hops. This can't be greater than 7.
Default of 3
Attempting to set a value > 7 results in the default
Content copied to clipboard
uint32 hop_limit = 8;
Link copied to clipboard
For testing it is useful sometimes to force a node to never listen to
particular other nodes (simulating radio out of range). All nodenums listed
in ignore_incoming will have packets they send dropped on receive (by router.cpp)
Content copied to clipboard
repeated uint32 ignore_incoming = 103;
Link copied to clipboard
If true, the device will not process any packets received via LoRa that passed via MQTT anywhere on the path towards it.
Content copied to clipboard
bool ignore_mqtt = 104;
Link copied to clipboard
Either modem_config or bandwidth/spreading/coding will be specified - NOT BOTH.
As a heuristic: If bandwidth is specified, do not use modem_config.
Because protobufs take ZERO space when the value is zero this works out nicely.
This value is replaced by bandwidth/spread_factor/coding_rate.
If you'd like to experiment with other options add them to MeshRadio.cpp in the device code.
Content copied to clipboard
.meshtastic.Config.LoRaConfig.ModemPreset modem_preset = 2;
Link copied to clipboard
If true, duty cycle limits will be exceeded and thus you're possibly not following
the local regulations if you're not a HAM.
Has no effect if the duty cycle of the used region is 100%.
Content copied to clipboard
bool override_duty_cycle = 12;
Link copied to clipboard
This parameter is for advanced users and licensed HAM radio operators.
Ignore Channel Calculation and use this frequency instead. The frequency_offset
will still be applied. This will allow you to use out-of-band frequencies.
Please respect your local laws and regulations. If you are a HAM, make sure you
enable HAM mode and turn off encryption.
Content copied to clipboard
float override_frequency = 14;
Link copied to clipboard
If true, disable the build-in PA FAN using pin define in RF95_FAN_EN.
Content copied to clipboard
bool pa_fan_disabled = 15;
Link copied to clipboard
The region code for the radio (US, CN, EU433, etc...)
Content copied to clipboard
.meshtastic.Config.LoRaConfig.RegionCode region = 7;
Link copied to clipboard
A number from 7 to 12.
Indicates number of chirps per symbol as 1<<spread_factor.
Content copied to clipboard
uint32 spread_factor = 4;
Link copied to clipboard
If true, sets RX boosted gain mode on SX126X based radios
Content copied to clipboard
bool sx126x_rx_boosted_gain = 13;
Link copied to clipboard
Disable TX from the LoRa radio. Useful for hot-swapping antennas and other tests.
Defaults to false
Content copied to clipboard
bool tx_enabled = 9;
Link copied to clipboard
If zero, then use default max legal continuous power (ie. something that won't
burn out the radio hardware)
In most cases you should use zero here.
Units are in dBm.
Content copied to clipboard
int32 tx_power = 10;
Link copied to clipboard
When enabled, the `modem_preset` fields will be adhered to, else the `bandwidth`/`spread_factor`/`coding_rate`
will be taked from their respective manually defined fields
Content copied to clipboard
bool use_preset = 1;
Link copied to clipboard
Bandwidth in MHz
Certain bandwidth numbers are 'special' and will be converted to the
appropriate floating point value: 31 -> 31.25MHz
Content copied to clipboard
uint32 bandwidth = 3;
Link copied to clipboard
This controls the actual hardware frequency the radio transmits on.
Most users should never need to be exposed to this field/concept.
A channel number between 1 and NUM_CHANNELS (whatever the max is in the current region).
If ZERO then the rule is "use the old channel name hash based
algorithm to derive the channel number")
If using the hash algorithm the channel number will be: hash(channel_name) %
NUM_CHANNELS (Where num channels depends on the regulatory region).
Content copied to clipboard
uint32 channel_num = 11;
Link copied to clipboard
The denominator of the coding rate.
ie for 4/5, the value is 5. 4/8 the value is 8.
Content copied to clipboard
uint32 coding_rate = 5;
Link copied to clipboard
Sets the ok_to_mqtt bit on outgoing packets
Content copied to clipboard
bool config_ok_to_mqtt = 105;
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
This parameter is for advanced users with advanced test equipment, we do not recommend most users use it.
A frequency offset that is added to to the calculated band center frequency.
Used to correct for crystal calibration errors.
Content copied to clipboard
float frequency_offset = 6;
Link copied to clipboard
Maximum number of hops. This can't be greater than 7.
Default of 3
Attempting to set a value > 7 results in the default
Content copied to clipboard
uint32 hop_limit = 8;
Link copied to clipboard
For testing it is useful sometimes to force a node to never listen to
particular other nodes (simulating radio out of range). All nodenums listed
in ignore_incoming will have packets they send dropped on receive (by router.cpp)
Content copied to clipboard
repeated uint32 ignore_incoming = 103;
Link copied to clipboard
For testing it is useful sometimes to force a node to never listen to
particular other nodes (simulating radio out of range). All nodenums listed
in ignore_incoming will have packets they send dropped on receive (by router.cpp)
Content copied to clipboard
repeated uint32 ignore_incoming = 103;
Link copied to clipboard
For testing it is useful sometimes to force a node to never listen to
particular other nodes (simulating radio out of range). All nodenums listed
in ignore_incoming will have packets they send dropped on receive (by router.cpp)
Content copied to clipboard
repeated uint32 ignore_incoming = 103;
Link copied to clipboard
If true, the device will not process any packets received via LoRa that passed via MQTT anywhere on the path towards it.
Content copied to clipboard
bool ignore_mqtt = 104;
Link copied to clipboard
Either modem_config or bandwidth/spreading/coding will be specified - NOT BOTH.
As a heuristic: If bandwidth is specified, do not use modem_config.
Because protobufs take ZERO space when the value is zero this works out nicely.
This value is replaced by bandwidth/spread_factor/coding_rate.
If you'd like to experiment with other options add them to MeshRadio.cpp in the device code.
Content copied to clipboard
.meshtastic.Config.LoRaConfig.ModemPreset modem_preset = 2;
Link copied to clipboard
Either modem_config or bandwidth/spreading/coding will be specified - NOT BOTH.
As a heuristic: If bandwidth is specified, do not use modem_config.
Because protobufs take ZERO space when the value is zero this works out nicely.
This value is replaced by bandwidth/spread_factor/coding_rate.
If you'd like to experiment with other options add them to MeshRadio.cpp in the device code.
Content copied to clipboard
.meshtastic.Config.LoRaConfig.ModemPreset modem_preset = 2;
Link copied to clipboard
If true, duty cycle limits will be exceeded and thus you're possibly not following
the local regulations if you're not a HAM.
Has no effect if the duty cycle of the used region is 100%.
Content copied to clipboard
bool override_duty_cycle = 12;
Link copied to clipboard
This parameter is for advanced users and licensed HAM radio operators.
Ignore Channel Calculation and use this frequency instead. The frequency_offset
will still be applied. This will allow you to use out-of-band frequencies.
Please respect your local laws and regulations. If you are a HAM, make sure you
enable HAM mode and turn off encryption.
Content copied to clipboard
float override_frequency = 14;
Link copied to clipboard
If true, disable the build-in PA FAN using pin define in RF95_FAN_EN.
Content copied to clipboard
bool pa_fan_disabled = 15;
Link copied to clipboard
The region code for the radio (US, CN, EU433, etc...)
Content copied to clipboard
.meshtastic.Config.LoRaConfig.RegionCode region = 7;
Link copied to clipboard
The region code for the radio (US, CN, EU433, etc...)
Content copied to clipboard
.meshtastic.Config.LoRaConfig.RegionCode region = 7;
Link copied to clipboard
A number from 7 to 12.
Indicates number of chirps per symbol as 1<<spread_factor.
Content copied to clipboard
uint32 spread_factor = 4;
Link copied to clipboard
If true, sets RX boosted gain mode on SX126X based radios
Content copied to clipboard
bool sx126x_rx_boosted_gain = 13;
Link copied to clipboard
Disable TX from the LoRa radio. Useful for hot-swapping antennas and other tests.
Defaults to false
Content copied to clipboard
bool tx_enabled = 9;
Link copied to clipboard
If zero, then use default max legal continuous power (ie. something that won't
burn out the radio hardware)
In most cases you should use zero here.
Units are in dBm.
Content copied to clipboard
int32 tx_power = 10;
Link copied to clipboard
When enabled, the `modem_preset` fields will be adhered to, else the `bandwidth`/`spread_factor`/`coding_rate`
will be taked from their respective manually defined fields
Content copied to clipboard
bool use_preset = 1;
Link copied to clipboard
Link copied to clipboard
open fun mergeFrom(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): ConfigProtos.Config.LoRaConfig.Builder
Link copied to clipboard
Bandwidth in MHz
Certain bandwidth numbers are 'special' and will be converted to the
appropriate floating point value: 31 -> 31.25MHz
Content copied to clipboard
uint32 bandwidth = 3;
Link copied to clipboard
This controls the actual hardware frequency the radio transmits on.
Most users should never need to be exposed to this field/concept.
A channel number between 1 and NUM_CHANNELS (whatever the max is in the current region).
If ZERO then the rule is "use the old channel name hash based
algorithm to derive the channel number")
If using the hash algorithm the channel number will be: hash(channel_name) %
NUM_CHANNELS (Where num channels depends on the regulatory region).
Content copied to clipboard
uint32 channel_num = 11;
Link copied to clipboard
The denominator of the coding rate.
ie for 4/5, the value is 5. 4/8 the value is 8.
Content copied to clipboard
uint32 coding_rate = 5;
Link copied to clipboard
Sets the ok_to_mqtt bit on outgoing packets
Content copied to clipboard
bool config_ok_to_mqtt = 105;
Link copied to clipboard
This parameter is for advanced users with advanced test equipment, we do not recommend most users use it.
A frequency offset that is added to to the calculated band center frequency.
Used to correct for crystal calibration errors.
Content copied to clipboard
float frequency_offset = 6;
Link copied to clipboard
Maximum number of hops. This can't be greater than 7.
Default of 3
Attempting to set a value > 7 results in the default
Content copied to clipboard
uint32 hop_limit = 8;
Link copied to clipboard
For testing it is useful sometimes to force a node to never listen to
particular other nodes (simulating radio out of range). All nodenums listed
in ignore_incoming will have packets they send dropped on receive (by router.cpp)
Content copied to clipboard
repeated uint32 ignore_incoming = 103;
Link copied to clipboard
If true, the device will not process any packets received via LoRa that passed via MQTT anywhere on the path towards it.
Content copied to clipboard
bool ignore_mqtt = 104;
Link copied to clipboard
open fun setModemPreset(value: ConfigProtos.Config.LoRaConfig.ModemPreset): ConfigProtos.Config.LoRaConfig.Builder
Either modem_config or bandwidth/spreading/coding will be specified - NOT BOTH.
As a heuristic: If bandwidth is specified, do not use modem_config.
Because protobufs take ZERO space when the value is zero this works out nicely.
This value is replaced by bandwidth/spread_factor/coding_rate.
If you'd like to experiment with other options add them to MeshRadio.cpp in the device code.
Content copied to clipboard
.meshtastic.Config.LoRaConfig.ModemPreset modem_preset = 2;
Link copied to clipboard
Either modem_config or bandwidth/spreading/coding will be specified - NOT BOTH.
As a heuristic: If bandwidth is specified, do not use modem_config.
Because protobufs take ZERO space when the value is zero this works out nicely.
This value is replaced by bandwidth/spread_factor/coding_rate.
If you'd like to experiment with other options add them to MeshRadio.cpp in the device code.
Content copied to clipboard
.meshtastic.Config.LoRaConfig.ModemPreset modem_preset = 2;
Link copied to clipboard
If true, duty cycle limits will be exceeded and thus you're possibly not following
the local regulations if you're not a HAM.
Has no effect if the duty cycle of the used region is 100%.
Content copied to clipboard
bool override_duty_cycle = 12;
Link copied to clipboard
This parameter is for advanced users and licensed HAM radio operators.
Ignore Channel Calculation and use this frequency instead. The frequency_offset
will still be applied. This will allow you to use out-of-band frequencies.
Please respect your local laws and regulations. If you are a HAM, make sure you
enable HAM mode and turn off encryption.
Content copied to clipboard
float override_frequency = 14;
Link copied to clipboard
If true, disable the build-in PA FAN using pin define in RF95_FAN_EN.
Content copied to clipboard
bool pa_fan_disabled = 15;
Link copied to clipboard
open fun setRegion(value: ConfigProtos.Config.LoRaConfig.RegionCode): ConfigProtos.Config.LoRaConfig.Builder
The region code for the radio (US, CN, EU433, etc...)
Content copied to clipboard
.meshtastic.Config.LoRaConfig.RegionCode region = 7;
Link copied to clipboard
The region code for the radio (US, CN, EU433, etc...)
Content copied to clipboard
.meshtastic.Config.LoRaConfig.RegionCode region = 7;
Link copied to clipboard
A number from 7 to 12.
Indicates number of chirps per symbol as 1<<spread_factor.
Content copied to clipboard
uint32 spread_factor = 4;
Link copied to clipboard
If true, sets RX boosted gain mode on SX126X based radios
Content copied to clipboard
bool sx126x_rx_boosted_gain = 13;
Link copied to clipboard
Disable TX from the LoRa radio. Useful for hot-swapping antennas and other tests.
Defaults to false
Content copied to clipboard
bool tx_enabled = 9;
Link copied to clipboard
If zero, then use default max legal continuous power (ie. something that won't
burn out the radio hardware)
In most cases you should use zero here.
Units are in dBm.
Content copied to clipboard
int32 tx_power = 10;
Link copied to clipboard
When enabled, the `modem_preset` fields will be adhered to, else the `bandwidth`/`spread_factor`/`coding_rate`
will be taked from their respective manually defined fields
Content copied to clipboard
bool use_preset = 1;